emv_data.h

Go to the documentation of this file.

#ifndef EMV_DATA_H
#define EMV_DATA_H
 
/* ************************ EMV KERNEL data processing functions *************************** */
/* ***************************************************************************************** */
 
/* set struct alignment */
#include <emv_platform_set_align.h>
 
/* ******************************** Search mode definition ********************************* */
#define KER_FIND_LAST                   0x01    
/* ******************************** Selected CVM definition ******************************** */
#define KER_CVM_FAIL                    0x00    
#define KER_CVM_SKIP                    0x01    
#define KER_CVM_NO_CVM              0x02    
#define KER_CVM_ONLINE_PIN      0x03    
#define KER_CVM_PLAIN_PIN           0x04    
#define KER_CVM_ENC_PIN             0x05    
#define KER_CVM_PLAIN_PIN_SIG   0x06    
#define KER_CVM_ENC_PIN_SIG     0x07    
#define KER_CVM_SIGNATURE           0x08    
#define KER_CVM_CUSTOM              0xFF    
/* ******************************** CVM Results definition ********************************* */
#define KER_CVM_RES_OK              0x00    
#define KER_CVM_RES_FAIL            0x01    
#define KER_CVM_RES_BYPASS      0x02    
#define KER_CVM_RES_UNKNOWN     0x03    
#define KER_CVM_RES_UNSUPP      0x04    
#define KER_CVM_RES_UNREC           0x05    
#define KER_CVM_RES_CANCEL      0x06    
#define KER_CVM_RES_HW_ERR      0x07    
/* ****************************** Referral Results definition ****************************** */
#define KER_REFFERAL_RES_NA                             0x00    
#define KER_REFFERAL_RES_APPROVE                    0x01    
#define KER_REFFERAL_RES_DECLINE                    0x02    
/* ********************************* TAA mode definition *********************************** */
#define KER_TAA_MODE_CHECK_OFFLINE_DECL     0x00    
#define KER_TAA_MODE_FINAL_BEFORE_CAA           0x01    
#define KER_TAA_MODE_UNABLE_TO_GO_ONLINE    0x02    
/* ************************************ KernelContTLV ************************************** */
/* ****************************** BER-TLV container structure ****************************** */
typedef struct tag_KER_TLV KER_TLV;
typedef struct tag_KER_TLV
{
    KER_BYTE* pbtTlv;               
    KER_INT16U usTlvLen;        
    KER_TLV* pNext;                 
} KER_TLV;
 
/* ********************************** PIN data structure *********************************** */
typedef struct tag_KER_OFFLINE_PIN_DATA
{
    KER_INT16U usSize;                              
    KER_BYTE btPinTryCount;                     
    KER_BYTE btOdeScheme;                           
    KER_BYTE ar_btOdeUN[8];                     
    KER_INT16U usOdeUNLen;
 
    union
    {
        struct
        {
            KER_BYTE btAlg;                             
            const KER_BYTE* pbtOdePK;           
            KER_INT16U usOdePKLen;
            const KER_BYTE* pbtOdePKExp;    
            KER_INT16U usOdePKExpLen;
        }RSA;
        struct
        {
            KER_BYTE btASI;                             
            const KER_BYTE* pbtOdePK;           
            KER_INT16U usOdePKLen;
        }ECC;
    }ODE;
} KER_OFFLINE_PIN_DATA;
 
/* ******************************** kerContTlvCreateByTag ********************************** */
extern KER_RES KER_API kerContTlvCreateByTag(KER_CTX_PARAM const KER_BYTE* pbtTag, KER_BYTE btTagLen, const KER_BYTE* pbtValue, KER_INT16U usValueLen, KER_TLV** ppTlv);
 
/* ******************************** kerContTlvCreateByTLV ********************************** */
extern KER_RES KER_API kerContTlvCreateByTLV(KER_CTX_PARAM const KER_BYTE* pbtTlv, KER_INT16U usTlvLen, KER_TLV** ppTlv);
 
/* ******************************** kerContTlvListAddByTLV ********************************* */
extern KER_RES KER_API kerContTlvListAddByTLV(KER_CTX_PARAM const KER_BYTE* pbtTlv, KER_INT16U usTlvLen, KER_TLV** ppTlv);
 
/* ********************************* kerContTlvRelease ************************************* */
extern KER_BOOL KER_API kerContTlvRelease(KER_CTX_PARAM KER_TLV* pTlv);
 
/* ******************************* kerContTlvListRelease *********************************** */
extern KER_BOOL KER_API kerContTlvListRelease(KER_CTX_PARAM KER_TLV* pTlvList);
 
/* ********************************* kerContTlvListPush ************************************ */
extern KER_BOOL KER_API kerContTlvListPush(KER_CTX_PARAM KER_TLV** ppTlv, KER_TLV* pTlvToPush);
 
/* ******************************* kerContTlvListPushLast ********************************** */
extern KER_BOOL KER_API kerContTlvListPushLast(KER_CTX_PARAM KER_TLV** ppTlv, KER_TLV* pTlvToPush);
 
/* ******************************** kerContTlvListGetNext ********************************** */
extern KER_TLV* KER_API kerContTlvListGetNext(KER_CTX_PARAM KER_TLV* pTlvListEntry);
 
/* ********************************* kerContTlvListPop ************************************* */
extern KER_BOOL KER_API kerContTlvListPop(KER_CTX_PARAM KER_TLV** ppTlv, KER_TLV* pTlvToPop);
 
/* ************************************* KernelTRAN **************************************** */
/* ****************************** Transaction data structure ******************************* */
typedef struct tag_KER_TRAN KER_TRAN;
 
/* *********************************** kerTranRelease ************************************** */
extern KER_BOOL KER_API kerTranRelease(KER_CTX_PARAM KER_TRAN* pTran);
 
/* ******************************** kerTranGetDataByTag ************************************ */
extern KER_BOOL KER_API kerTranGetDataByTag(KER_CTX_PARAM KER_TRAN* pTran, const KER_BYTE* pbtTag, KER_BYTE btTagLen, KER_BYTE* pbtData, KER_INT16U* pusDataLen, KER_INT16U usDataMax);
 
/* ****************************** kerTranGetCustDataByTag ********************************** */
extern KER_BOOL KER_API kerTranGetCustDataByTag(KER_CTX_PARAM KER_TRAN* pTran, const KER_BYTE* pbtTag, KER_BYTE btTagLen, KER_BYTE* pbtData, KER_INT16U* pusDataLen, KER_INT16U usDataMax);
 
/* ******************************** kerTranGetDataByDOL ************************************ */
extern KER_BOOL KER_API kerTranGetDataByDOL(KER_CTX_PARAM KER_TRAN* pTran, const KER_BYTE* pbtDol, KER_INT16U usDolLen, KER_BYTE* pbtData, KER_INT16U* pusDataLen, KER_INT16U usDataMax);
 
/* ******************************** kerTranGetCardData ************************************* */
extern KER_BOOL KER_API kerTranGetCardData(KER_CTX_PARAM KER_TRAN* pTran, const KER_BYTE* pbtTag, KER_BYTE btTagLen, KER_BYTE* pbtData, KER_INT16U* pusDataLen, KER_INT16U usDataMax);
 
/* ****************************** kerTranGetScriptResults ********************************** */
extern KER_BOOL KER_API kerTranGetScriptResults(KER_CTX_PARAM KER_TRAN* pTran, KER_BYTE* pbtData, KER_INT16U* pusDataLen, KER_INT16U usDataMax);
 
/* **************************** kerTranGetScriptResultsRef ********************************* */
extern KER_BOOL KER_API kerTranGetScriptResultsRef(KER_CTX_PARAM KER_TRAN* pTran, KER_INT16U usScriptIndex, KER_BYTE* pbtData, KER_INT16U* pusDataLen, KER_INT16U usDataMax);
 
/* ********************************** kerTranGetFlags ************************************** */
#define KER_TRAN_FL_SIGNATURE_CVM_REQUESTED         0x0001      
#define KER_TRAN_FL_APP_VER_MISMATCH                        0x0002      
#define KER_TRAN_FL_TAA_OFFLINE_DECLINED                0x0004      
#define KER_TRAN_FL_TAA_ONLINE_REQUEST                  0x0008      
#define KER_TRAN_FL_TAA_OFFLINE_APPROVE                 0x0010      
#define KER_TRAN_FL_CAA_OFFLINE_DECLINED                0x0020      
#define KER_TRAN_FL_CAA_ONLINE_REQUEST                  0x0040      
#define KER_TRAN_FL_CAA_OFFLINE_APPROVED                0x0080      
#define KER_TRAN_FL_TAA_DEFAULT_APPROVE                 0x0100      
#define KER_TRAN_FL_TAA_DEFAULT_DECLINED                0x0200      
#define KER_TRAN_FL_CAA_SKIP_GAC2_BY_XDA                0x0400      
#define KER_TRAN_FL_ADVICE_REQUIRED                         0x1000      
#define KER_TRAN_FL_SERVICE_NOT_ALLOWWED                0x2000      
#define KER_TRAN_FL_PIN_TRY_EXCEEDED                        0x4000      
#define KER_TRAN_FL_ISS_AUTH_FAILED                         0x8000      
extern KER_INT16U KER_API kerTranGetFlags(KER_CTX_PARAM KER_TRAN* pTran);
 
/* ******************************* kerTranGetErrorFlags ************************************ */
#define KER_TRAN_ERR_FL_PAN_MISMATCH                        0x0001      
#define KER_TRAN_ERR_FL_EXP_DATE_MISMATCH               0x0002      
#define KER_TRAN_ERR_FL_INV_AUTH_DATA                       0x0004      
#define KER_TRAN_ERR_FL_PDOL_MAND_AMOUNT_MISSED 0x0008      
extern KER_INT16U KER_API kerTranGetErrorFlags(KER_CTX_PARAM KER_TRAN* pTran);
 
/* ********************************** kerTranGetStatus ************************************* */
#define KER_TRAN_STAT_APP_SELECTED                          0x0001      
#define KER_TRAN_STAT_PROC_INITIATED                        0x0002      
#define KER_TRAN_STAT_READ_DATA                                 0x0004      
#define KER_TRAN_STAT_OFFLINE_AUTH                          0x0008      
#define KER_TRAN_STAT_PROC_RESTR                                0x0010      
#define KER_TRAN_STAT_CV                                                0x0020      
#define KER_TRAN_STAT_RISK_MANAGEMENT                       0x0040      
#define KER_TRAN_STAT_CAA                                               0x0080      
#define KER_TRAN_STAT_ONLINE                                        0x0100      
extern KER_INT16U KER_API kerTranGetStatus(KER_CTX_PARAM KER_TRAN* pTran);
 
/* restore struct alignment */
#include <emv_platform_restore_align.h>
 
#endif /* EMV_DATA_H */